home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chpevd.z / chpevd
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHPEVD - compute all the eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian matrix A in packed storage
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHPEVD( JOBZ, UPLO, N, AP, W, Z, LDZ, WORK, LWORK, RWORK,
  14.                         LRWORK, IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, LDZ, LIWORK, LRWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           RWORK( * ), W( * )
  23.  
  24.          COMPLEX        AP( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      CHPEVD computes all the eigenvalues and, optionally, eigenvectors of a
  41.      complex Hermitian matrix A in packed storage. If eigenvectors are
  42.      desired, it uses a divide and conquer algorithm.
  43.  
  44.      The divide and conquer algorithm makes very mild assumptions about
  45.      floating point arithmetic. It will work on machines with a guard digit in
  46.      add/subtract, or on those binary machines without guard digits which
  47.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  48.      conceivably fail on hexadecimal or decimal machines without guard digits,
  49.      but we know of none.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      JOBZ    (input) CHARACTER*1
  54.              = 'N':  Compute eigenvalues only;
  55.              = 'V':  Compute eigenvalues and eigenvectors.
  56.  
  57.      UPLO    (input) CHARACTER*1
  58.              = 'U':  Upper triangle of A is stored;
  59.              = 'L':  Lower triangle of A is stored.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      AP      (input/output) COMPLEX array, dimension (N*(N+1)/2)
  78.              On entry, the upper or lower triangle of the Hermitian matrix A,
  79.              packed columnwise in a linear array.  The j-th column of A is
  80.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  81.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  82.              j)/2) = A(i,j) for j<=i<=n.
  83.  
  84.              On exit, AP is overwritten by values generated during the
  85.              reduction to tridiagonal form.  If UPLO = 'U', the diagonal and
  86.              first superdiagonal of the tridiagonal matrix T overwrite the
  87.              corresponding elements of A, and if UPLO = 'L', the diagonal and
  88.              first subdiagonal of T overwrite the corresponding elements of A.
  89.  
  90.      W       (output) REAL array, dimension (N)
  91.              If INFO = 0, the eigenvalues in ascending order.
  92.  
  93.      Z       (output) COMPLEX array, dimension (LDZ, N)
  94.              If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal
  95.              eigenvectors of the matrix A, with the i-th column of Z holding
  96.              the eigenvector associated with W(i).  If JOBZ = 'N', then Z is
  97.              not referenced.
  98.  
  99.      LDZ     (input) INTEGER
  100.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  101.              'V', LDZ >= max(1,N).
  102.  
  103.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  104.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  105.  
  106.      LWORK   (input) INTEGER
  107.              The dimension of array WORK.  If N <= 1,               LWORK must
  108.              be at least 1.  If JOBZ = 'N' and N > 1, LWORK must be at least
  109.              N.  If JOBZ = 'V' and N > 1, LWORK must be at least 2*N.
  110.  
  111.              If LWORK = -1, then a workspace query is assumed; the routine
  112.              only calculates the optimal size of the WORK array, returns this
  113.              value as the first entry of the WORK array, and no error message
  114.              related to LWORK is issued by XERBLA.
  115.  
  116.      RWORK   (workspace/output) REAL array,
  117.              dimension (LRWORK) On exit, if INFO = 0, RWORK(1) returns the
  118.              optimal LRWORK.
  119.  
  120.      LRWORK  (input) INTEGER
  121.              The dimension of array RWORK.  If N <= 1,               LRWORK
  122.              must be at least 1.  If JOBZ = 'N' and N > 1, LRWORK must be at
  123.              least N.  If JOBZ = 'V' and N > 1, LRWORK must be at least 1 +
  124.              5*N + 2*N**2.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHPPPPEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              If LRWORK = -1, then a workspace query is assumed; the routine
  141.              only calculates the optimal size of the RWORK array, returns this
  142.              value as the first entry of the RWORK array, and no error message
  143.              related to LRWORK is issued by XERBLA.
  144.  
  145.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  146.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  147.  
  148.      LIWORK  (input) INTEGER
  149.              The dimension of array IWORK.  If JOBZ  = 'N' or N <= 1, LIWORK
  150.              must be at least 1.  If JOBZ  = 'V' and N > 1, LIWORK must be at
  151.              least 3 + 5*N.
  152.  
  153.              If LIWORK = -1, then a workspace query is assumed; the routine
  154.              only calculates the optimal size of the IWORK array, returns this
  155.              value as the first entry of the IWORK array, and no error message
  156.              related to LIWORK is issued by XERBLA.
  157.  
  158.      INFO    (output) INTEGER
  159.              = 0:  successful exit
  160.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  161.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  162.              diagonal elements of an intermediate tridiagonal form did not
  163.              converge to zero.
  164.  
  165. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  166.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  167.  
  168.      This man page is available only online.
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.